home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimpquerybox.sgml < prev    next >
Encoding:
SGML Document  |  2003-05-20  |  30.0 KB  |  564 lines
  1. <refentry id="libgimp-gimpquerybox" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimpquerybox</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimpquerybox</refname><refpurpose>Some simple dialogs to enter a single int, double, string or boolean value.</refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. void        (<link linkend="GimpQueryStringCallback">*GimpQueryStringCallback</link>)      (<link linkend="GtkWidget">GtkWidget</link> *query_box,
  18.                                              <link linkend="gchar">gchar</link> *string,
  19.                                              <link linkend="gpointer">gpointer</link> data);
  20. void        (<link linkend="GimpQueryIntCallback">*GimpQueryIntCallback</link>)         (<link linkend="GtkWidget">GtkWidget</link> *query_box,
  21.                                              <link linkend="gint">gint</link> value,
  22.                                              <link linkend="gpointer">gpointer</link> data);
  23. void        (<link linkend="GimpQueryDoubleCallback">*GimpQueryDoubleCallback</link>)      (<link linkend="GtkWidget">GtkWidget</link> *query_box,
  24.                                              <link linkend="gdouble">gdouble</link> value,
  25.                                              <link linkend="gpointer">gpointer</link> data);
  26. void        (<link linkend="GimpQuerySizeCallback">*GimpQuerySizeCallback</link>)        (<link linkend="GtkWidget">GtkWidget</link> *query_box,
  27.                                              <link linkend="gdouble">gdouble</link> size,
  28.                                              <link linkend="GimpUnit">GimpUnit</link> unit,
  29.                                              <link linkend="gpointer">gpointer</link> data);
  30. void        (<link linkend="GimpQueryBooleanCallback">*GimpQueryBooleanCallback</link>)     (<link linkend="GtkWidget">GtkWidget</link> *query_box,
  31.                                              <link linkend="gboolean">gboolean</link> value,
  32.                                              <link linkend="gpointer">gpointer</link> data);
  33. <link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-query-string-box">gimp_query_string_box</link>           (const <link linkend="gchar">gchar</link> *title,
  34.                                              <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
  35.                                              const <link linkend="gchar">gchar</link> *help_data,
  36.                                              const <link linkend="gchar">gchar</link> *message,
  37.                                              const <link linkend="gchar">gchar</link> *initial,
  38.                                              <link linkend="GtkObject">GtkObject</link> *object,
  39.                                              const <link linkend="gchar">gchar</link> *signal,
  40.                                              <link linkend="GimpQueryStringCallback">GimpQueryStringCallback</link> callback,
  41.                                              <link linkend="gpointer">gpointer</link> data);
  42. <link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-query-int-box">gimp_query_int_box</link>              (const <link linkend="gchar">gchar</link> *title,
  43.                                              <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
  44.                                              const <link linkend="gchar">gchar</link> *help_data,
  45.                                              const <link linkend="gchar">gchar</link> *message,
  46.                                              <link linkend="gint">gint</link> initial,
  47.                                              <link linkend="gint">gint</link> lower,
  48.                                              <link linkend="gint">gint</link> upper,
  49.                                              <link linkend="GtkObject">GtkObject</link> *object,
  50.                                              const <link linkend="gchar">gchar</link> *signal,
  51.                                              <link linkend="GimpQueryIntCallback">GimpQueryIntCallback</link> callback,
  52.                                              <link linkend="gpointer">gpointer</link> data);
  53. <link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-query-double-box">gimp_query_double_box</link>           (const <link linkend="gchar">gchar</link> *title,
  54.                                              <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
  55.                                              const <link linkend="gchar">gchar</link> *help_data,
  56.                                              const <link linkend="gchar">gchar</link> *message,
  57.                                              <link linkend="gdouble">gdouble</link> initial,
  58.                                              <link linkend="gdouble">gdouble</link> lower,
  59.                                              <link linkend="gdouble">gdouble</link> upper,
  60.                                              <link linkend="gint">gint</link> digits,
  61.                                              <link linkend="GtkObject">GtkObject</link> *object,
  62.                                              const <link linkend="gchar">gchar</link> *signal,
  63.                                              <link linkend="GimpQueryDoubleCallback">GimpQueryDoubleCallback</link> callback,
  64.                                              <link linkend="gpointer">gpointer</link> data);
  65. <link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-query-size-box">gimp_query_size_box</link>             (const <link linkend="gchar">gchar</link> *title,
  66.                                              <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
  67.                                              const <link linkend="gchar">gchar</link> *help_data,
  68.                                              const <link linkend="gchar">gchar</link> *message,
  69.                                              <link linkend="gdouble">gdouble</link> initial,
  70.                                              <link linkend="gdouble">gdouble</link> lower,
  71.                                              <link linkend="gdouble">gdouble</link> upper,
  72.                                              <link linkend="gint">gint</link> digits,
  73.                                              <link linkend="GimpUnit">GimpUnit</link> unit,
  74.                                              <link linkend="gdouble">gdouble</link> resolution,
  75.                                              <link linkend="gboolean">gboolean</link> dot_for_dot,
  76.                                              <link linkend="GtkObject">GtkObject</link> *object,
  77.                                              const <link linkend="gchar">gchar</link> *signal,
  78.                                              <link linkend="GimpQuerySizeCallback">GimpQuerySizeCallback</link> callback,
  79.                                              <link linkend="gpointer">gpointer</link> data);
  80. <link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-query-boolean-box">gimp_query_boolean_box</link>          (const <link linkend="gchar">gchar</link> *title,
  81.                                              <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
  82.                                              const <link linkend="gchar">gchar</link> *help_data,
  83.                                              <link linkend="gboolean">gboolean</link> eek,
  84.                                              const <link linkend="gchar">gchar</link> *message,
  85.                                              const <link linkend="gchar">gchar</link> *true_button,
  86.                                              const <link linkend="gchar">gchar</link> *false_button,
  87.                                              <link linkend="GtkObject">GtkObject</link> *object,
  88.                                              const <link linkend="gchar">gchar</link> *signal,
  89.                                              <link linkend="GimpQueryBooleanCallback">GimpQueryBooleanCallback</link> callback,
  90.                                              <link linkend="gpointer">gpointer</link> data);
  91. </synopsis>
  92. </refsynopsisdiv>
  93.  
  94.  
  95.  
  96.  
  97.  
  98. <refsect1>
  99. <title>Description</title>
  100. <para>
  101. These functions provide simple dialogs for entering a single string,
  102. integer, double, boolean or pixel size value.
  103. </para>
  104. <para>
  105. They return a pointer to a <link linkend="GtkDialog">GtkDialog</link> which has to be shown with
  106. <link linkend="gtk-widget-show">gtk_widget_show</link>() by the caller.
  107. </para>
  108. <para>
  109. The dialogs contain an entry widget for the kind of value they ask for
  110. and "OK" and "Cancel" buttons. On "Cancel", all query boxes except the
  111. boolean one silently destroy themselves. On "OK" the user defined
  112. callback function is called and returns the entered value.
  113. </para>
  114. </refsect1>
  115.  
  116. <refsect1>
  117. <title>Details</title>
  118. <refsect2>
  119. <title><anchor id="GimpQueryStringCallback">GimpQueryStringCallback ()</title>
  120. <programlisting>void        (*GimpQueryStringCallback)      (<link linkend="GtkWidget">GtkWidget</link> *query_box,
  121.                                              <link linkend="gchar">gchar</link> *string,
  122.                                              <link linkend="gpointer">gpointer</link> data);</programlisting>
  123. <para>
  124. Note that you have to <link linkend="g-free">g_free</link>() the returned string.
  125. </para><informaltable pgwide=1 frame="none" role="params">
  126. <tgroup cols="2">
  127. <colspec colwidth="2*">
  128. <colspec colwidth="8*">
  129. <tbody>
  130. <row><entry align="right"><parameter>query_box</parameter> :</entry>
  131. <entry>The query box.
  132. </entry></row>
  133. <row><entry align="right"><parameter>string</parameter> :</entry>
  134. <entry>The entered string.
  135. </entry></row>
  136. <row><entry align="right"><parameter>data</parameter> :</entry>
  137. <entry>The user data.
  138.  
  139.  
  140. </entry></row>
  141. </tbody></tgroup></informaltable></refsect2>
  142. <refsect2>
  143. <title><anchor id="GimpQueryIntCallback">GimpQueryIntCallback ()</title>
  144. <programlisting>void        (*GimpQueryIntCallback)         (<link linkend="GtkWidget">GtkWidget</link> *query_box,
  145.                                              <link linkend="gint">gint</link> value,
  146.                                              <link linkend="gpointer">gpointer</link> data);</programlisting>
  147. <para>
  148.  
  149. </para><informaltable pgwide=1 frame="none" role="params">
  150. <tgroup cols="2">
  151. <colspec colwidth="2*">
  152. <colspec colwidth="8*">
  153. <tbody>
  154. <row><entry align="right"><parameter>query_box</parameter> :</entry>
  155. <entry>The query box.
  156. </entry></row>
  157. <row><entry align="right"><parameter>value</parameter> :</entry>
  158. <entry>The entered integer value.
  159. </entry></row>
  160. <row><entry align="right"><parameter>data</parameter> :</entry>
  161. <entry>The user data.
  162.  
  163.  
  164. </entry></row>
  165. </tbody></tgroup></informaltable></refsect2>
  166. <refsect2>
  167. <title><anchor id="GimpQueryDoubleCallback">GimpQueryDoubleCallback ()</title>
  168. <programlisting>void        (*GimpQueryDoubleCallback)      (<link linkend="GtkWidget">GtkWidget</link> *query_box,
  169.                                              <link linkend="gdouble">gdouble</link> value,
  170.                                              <link linkend="gpointer">gpointer</link> data);</programlisting>
  171. <para>
  172.  
  173. </para><informaltable pgwide=1 frame="none" role="params">
  174. <tgroup cols="2">
  175. <colspec colwidth="2*">
  176. <colspec colwidth="8*">
  177. <tbody>
  178. <row><entry align="right"><parameter>query_box</parameter> :</entry>
  179. <entry>The query box.
  180. </entry></row>
  181. <row><entry align="right"><parameter>value</parameter> :</entry>
  182. <entry>The entered double value.
  183. </entry></row>
  184. <row><entry align="right"><parameter>data</parameter> :</entry>
  185. <entry>The user data.
  186.  
  187.  
  188. </entry></row>
  189. </tbody></tgroup></informaltable></refsect2>
  190. <refsect2>
  191. <title><anchor id="GimpQuerySizeCallback">GimpQuerySizeCallback ()</title>
  192. <programlisting>void        (*GimpQuerySizeCallback)        (<link linkend="GtkWidget">GtkWidget</link> *query_box,
  193.                                              <link linkend="gdouble">gdouble</link> size,
  194.                                              <link linkend="GimpUnit">GimpUnit</link> unit,
  195.                                              <link linkend="gpointer">gpointer</link> data);</programlisting>
  196. <para>
  197.  
  198. </para><informaltable pgwide=1 frame="none" role="params">
  199. <tgroup cols="2">
  200. <colspec colwidth="2*">
  201. <colspec colwidth="8*">
  202. <tbody>
  203. <row><entry align="right"><parameter>query_box</parameter> :</entry>
  204. <entry>The query box.
  205. </entry></row>
  206. <row><entry align="right"><parameter>size</parameter> :</entry>
  207. <entry>The entered size in pixels.
  208. </entry></row>
  209. <row><entry align="right"><parameter>unit</parameter> :</entry>
  210. <entry>The selected unit from the <link linkend="GimpUnitMenu">GimpUnitMenu</link>.
  211. </entry></row>
  212. <row><entry align="right"><parameter>data</parameter> :</entry>
  213. <entry>The user data.
  214.  
  215.  
  216. </entry></row>
  217. </tbody></tgroup></informaltable></refsect2>
  218. <refsect2>
  219. <title><anchor id="GimpQueryBooleanCallback">GimpQueryBooleanCallback ()</title>
  220. <programlisting>void        (*GimpQueryBooleanCallback)     (<link linkend="GtkWidget">GtkWidget</link> *query_box,
  221.                                              <link linkend="gboolean">gboolean</link> value,
  222.                                              <link linkend="gpointer">gpointer</link> data);</programlisting>
  223. <para>
  224.  
  225. </para><informaltable pgwide=1 frame="none" role="params">
  226. <tgroup cols="2">
  227. <colspec colwidth="2*">
  228. <colspec colwidth="8*">
  229. <tbody>
  230. <row><entry align="right"><parameter>query_box</parameter> :</entry>
  231. <entry>The query box.
  232. </entry></row>
  233. <row><entry align="right"><parameter>value</parameter> :</entry>
  234. <entry>The entered boolean value.
  235. </entry></row>
  236. <row><entry align="right"><parameter>data</parameter> :</entry>
  237. <entry>The user data.
  238.  
  239.  
  240. </entry></row>
  241. </tbody></tgroup></informaltable></refsect2>
  242. <refsect2>
  243. <title><anchor id="gimp-query-string-box">gimp_query_string_box ()</title>
  244. <programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_query_string_box           (const <link linkend="gchar">gchar</link> *title,
  245.                                              <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
  246.                                              const <link linkend="gchar">gchar</link> *help_data,
  247.                                              const <link linkend="gchar">gchar</link> *message,
  248.                                              const <link linkend="gchar">gchar</link> *initial,
  249.                                              <link linkend="GtkObject">GtkObject</link> *object,
  250.                                              const <link linkend="gchar">gchar</link> *signal,
  251.                                              <link linkend="GimpQueryStringCallback">GimpQueryStringCallback</link> callback,
  252.                                              <link linkend="gpointer">gpointer</link> data);</programlisting>
  253. <para>
  254. </para>
  255. <para>
  256.  
  257. </para><informaltable pgwide=1 frame="none" role="params">
  258. <tgroup cols="2">
  259. <colspec colwidth="2*">
  260. <colspec colwidth="8*">
  261. <tbody>
  262. <row><entry align="right"><parameter>title</parameter> :</entry>
  263. <entry> The query box dialog's title.
  264. </entry></row>
  265. <row><entry align="right"><parameter>help_func</parameter> :</entry>
  266. <entry> The help function to show this dialog's help page.
  267. </entry></row>
  268. <row><entry align="right"><parameter>help_data</parameter> :</entry>
  269. <entry> A string pointing to this dialog's html help page.
  270. </entry></row>
  271. <row><entry align="right"><parameter>message</parameter> :</entry>
  272. <entry> A string which will be shown above the dialog's entry widget.
  273. </entry></row>
  274. <row><entry align="right"><parameter>initial</parameter> :</entry>
  275. <entry> The initial value.
  276. </entry></row>
  277. <row><entry align="right"><parameter>object</parameter> :</entry>
  278. <entry> The object this query box is associated with.
  279. </entry></row>
  280. <row><entry align="right"><parameter>signal</parameter> :</entry>
  281. <entry> The object's signal which will cause the query box to be closed.
  282. </entry></row>
  283. <row><entry align="right"><parameter>callback</parameter> :</entry>
  284. <entry> The function which will be called when the user selects "OK".
  285. </entry></row>
  286. <row><entry align="right"><parameter>data</parameter> :</entry>
  287. <entry> The callback's user data.
  288. </entry></row>
  289. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> A pointer to the new <link linkend="GtkDialog">GtkDialog</link>.
  290. </entry></row>
  291. </tbody></tgroup></informaltable></refsect2>
  292. <refsect2>
  293. <title><anchor id="gimp-query-int-box">gimp_query_int_box ()</title>
  294. <programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_query_int_box              (const <link linkend="gchar">gchar</link> *title,
  295.                                              <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
  296.                                              const <link linkend="gchar">gchar</link> *help_data,
  297.                                              const <link linkend="gchar">gchar</link> *message,
  298.                                              <link linkend="gint">gint</link> initial,
  299.                                              <link linkend="gint">gint</link> lower,
  300.                                              <link linkend="gint">gint</link> upper,
  301.                                              <link linkend="GtkObject">GtkObject</link> *object,
  302.                                              const <link linkend="gchar">gchar</link> *signal,
  303.                                              <link linkend="GimpQueryIntCallback">GimpQueryIntCallback</link> callback,
  304.                                              <link linkend="gpointer">gpointer</link> data);</programlisting>
  305. <para>
  306. </para>
  307. <para>
  308.  
  309. </para><informaltable pgwide=1 frame="none" role="params">
  310. <tgroup cols="2">
  311. <colspec colwidth="2*">
  312. <colspec colwidth="8*">
  313. <tbody>
  314. <row><entry align="right"><parameter>title</parameter> :</entry>
  315. <entry> The query box dialog's title.
  316. </entry></row>
  317. <row><entry align="right"><parameter>help_func</parameter> :</entry>
  318. <entry> The help function to show this dialog's help page.
  319. </entry></row>
  320. <row><entry align="right"><parameter>help_data</parameter> :</entry>
  321. <entry> A string pointing to this dialog's html help page.
  322. </entry></row>
  323. <row><entry align="right"><parameter>message</parameter> :</entry>
  324. <entry> A string which will be shown above the dialog's entry widget.
  325. </entry></row>
  326. <row><entry align="right"><parameter>initial</parameter> :</entry>
  327. <entry> The initial value.
  328. </entry></row>
  329. <row><entry align="right"><parameter>lower</parameter> :</entry>
  330. <entry> The lower boundary of the range of possible values.
  331. </entry></row>
  332. <row><entry align="right"><parameter>upper</parameter> :</entry>
  333. <entry> The upper boundray of the range of possible values.
  334. </entry></row>
  335. <row><entry align="right"><parameter>object</parameter> :</entry>
  336. <entry> The object this query box is associated with.
  337. </entry></row>
  338. <row><entry align="right"><parameter>signal</parameter> :</entry>
  339. <entry> The object's signal which will cause the query box to be closed.
  340. </entry></row>
  341. <row><entry align="right"><parameter>callback</parameter> :</entry>
  342. <entry> The function which will be called when the user selects "OK".
  343. </entry></row>
  344. <row><entry align="right"><parameter>data</parameter> :</entry>
  345. <entry> The callback's user data.
  346. </entry></row>
  347. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> A pointer to the new <link linkend="GtkDialog">GtkDialog</link>.
  348. </entry></row>
  349. </tbody></tgroup></informaltable></refsect2>
  350. <refsect2>
  351. <title><anchor id="gimp-query-double-box">gimp_query_double_box ()</title>
  352. <programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_query_double_box           (const <link linkend="gchar">gchar</link> *title,
  353.                                              <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
  354.                                              const <link linkend="gchar">gchar</link> *help_data,
  355.                                              const <link linkend="gchar">gchar</link> *message,
  356.                                              <link linkend="gdouble">gdouble</link> initial,
  357.                                              <link linkend="gdouble">gdouble</link> lower,
  358.                                              <link linkend="gdouble">gdouble</link> upper,
  359.                                              <link linkend="gint">gint</link> digits,
  360.                                              <link linkend="GtkObject">GtkObject</link> *object,
  361.                                              const <link linkend="gchar">gchar</link> *signal,
  362.                                              <link linkend="GimpQueryDoubleCallback">GimpQueryDoubleCallback</link> callback,
  363.                                              <link linkend="gpointer">gpointer</link> data);</programlisting>
  364. <para>
  365. </para>
  366. <para>
  367.  
  368. </para><informaltable pgwide=1 frame="none" role="params">
  369. <tgroup cols="2">
  370. <colspec colwidth="2*">
  371. <colspec colwidth="8*">
  372. <tbody>
  373. <row><entry align="right"><parameter>title</parameter> :</entry>
  374. <entry> The query box dialog's title.
  375. </entry></row>
  376. <row><entry align="right"><parameter>help_func</parameter> :</entry>
  377. <entry> The help function to show this dialog's help page.
  378. </entry></row>
  379. <row><entry align="right"><parameter>help_data</parameter> :</entry>
  380. <entry> A string pointing to this dialog's html help page.
  381. </entry></row>
  382. <row><entry align="right"><parameter>message</parameter> :</entry>
  383. <entry> A string which will be shown above the dialog's entry widget.
  384. </entry></row>
  385. <row><entry align="right"><parameter>initial</parameter> :</entry>
  386. <entry> The initial value.
  387. </entry></row>
  388. <row><entry align="right"><parameter>lower</parameter> :</entry>
  389. <entry> The lower boundary of the range of possible values.
  390. </entry></row>
  391. <row><entry align="right"><parameter>upper</parameter> :</entry>
  392. <entry> The upper boundray of the range of possible values.
  393. </entry></row>
  394. <row><entry align="right"><parameter>digits</parameter> :</entry>
  395. <entry> The number of decimal digits the <link linkend="GtkSpinButton">GtkSpinButton</link> will provide.
  396. </entry></row>
  397. <row><entry align="right"><parameter>object</parameter> :</entry>
  398. <entry> The object this query box is associated with.
  399. </entry></row>
  400. <row><entry align="right"><parameter>signal</parameter> :</entry>
  401. <entry> The object's signal which will cause the query box to be closed.
  402. </entry></row>
  403. <row><entry align="right"><parameter>callback</parameter> :</entry>
  404. <entry> The function which will be called when the user selects "OK".
  405. </entry></row>
  406. <row><entry align="right"><parameter>data</parameter> :</entry>
  407. <entry> The callback's user data.
  408. </entry></row>
  409. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> A pointer to the new <link linkend="GtkDialog">GtkDialog</link>.
  410. </entry></row>
  411. </tbody></tgroup></informaltable></refsect2>
  412. <refsect2>
  413. <title><anchor id="gimp-query-size-box">gimp_query_size_box ()</title>
  414. <programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_query_size_box             (const <link linkend="gchar">gchar</link> *title,
  415.                                              <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
  416.                                              const <link linkend="gchar">gchar</link> *help_data,
  417.                                              const <link linkend="gchar">gchar</link> *message,
  418.                                              <link linkend="gdouble">gdouble</link> initial,
  419.                                              <link linkend="gdouble">gdouble</link> lower,
  420.                                              <link linkend="gdouble">gdouble</link> upper,
  421.                                              <link linkend="gint">gint</link> digits,
  422.                                              <link linkend="GimpUnit">GimpUnit</link> unit,
  423.                                              <link linkend="gdouble">gdouble</link> resolution,
  424.                                              <link linkend="gboolean">gboolean</link> dot_for_dot,
  425.                                              <link linkend="GtkObject">GtkObject</link> *object,
  426.                                              const <link linkend="gchar">gchar</link> *signal,
  427.                                              <link linkend="GimpQuerySizeCallback">GimpQuerySizeCallback</link> callback,
  428.                                              <link linkend="gpointer">gpointer</link> data);</programlisting>
  429. <para>
  430. </para>
  431. <para>
  432.  
  433. </para><informaltable pgwide=1 frame="none" role="params">
  434. <tgroup cols="2">
  435. <colspec colwidth="2*">
  436. <colspec colwidth="8*">
  437. <tbody>
  438. <row><entry align="right"><parameter>title</parameter> :</entry>
  439. <entry> The query box dialog's title.
  440. </entry></row>
  441. <row><entry align="right"><parameter>help_func</parameter> :</entry>
  442. <entry> The help function to show this dialog's help page.
  443. </entry></row>
  444. <row><entry align="right"><parameter>help_data</parameter> :</entry>
  445. <entry> A string pointing to this dialog's html help page.
  446. </entry></row>
  447. <row><entry align="right"><parameter>message</parameter> :</entry>
  448. <entry> A string which will be shown above the dialog's entry widget.
  449. </entry></row>
  450. <row><entry align="right"><parameter>initial</parameter> :</entry>
  451. <entry> The initial value.
  452. </entry></row>
  453. <row><entry align="right"><parameter>lower</parameter> :</entry>
  454. <entry> The lower boundary of the range of possible values.
  455. </entry></row>
  456. <row><entry align="right"><parameter>upper</parameter> :</entry>
  457. <entry> The upper boundray of the range of possible values.
  458. </entry></row>
  459. <row><entry align="right"><parameter>digits</parameter> :</entry>
  460. <entry> The number of decimal digits the <link linkend="GimpSizeEntry">GimpSizeEntry</link> provide in
  461. "pixel" mode.
  462. </entry></row>
  463. <row><entry align="right"><parameter>unit</parameter> :</entry>
  464. <entry> The unit initially shown by the <link linkend="GimpUnitMenu">GimpUnitMenu</link>.
  465. </entry></row>
  466. <row><entry align="right"><parameter>resolution</parameter> :</entry>
  467. <entry> The resolution (in dpi) which will be used for pixel/unit
  468. calculations.
  469. </entry></row>
  470. <row><entry align="right"><parameter>dot_for_dot</parameter> :</entry>
  471. <entry> <link linkend="TRUE-CAPS">TRUE</link> if the <link linkend="GimpUnitMenu">GimpUnitMenu</link>'s initial unit should be "pixels".
  472. </entry></row>
  473. <row><entry align="right"><parameter>object</parameter> :</entry>
  474. <entry> The object this query box is associated with.
  475. </entry></row>
  476. <row><entry align="right"><parameter>signal</parameter> :</entry>
  477. <entry> The object's signal which will cause the query box to be closed.
  478. </entry></row>
  479. <row><entry align="right"><parameter>callback</parameter> :</entry>
  480. <entry> The function which will be called when the user selects "OK".
  481. </entry></row>
  482. <row><entry align="right"><parameter>data</parameter> :</entry>
  483. <entry> The callback's user data.
  484. </entry></row>
  485. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> A pointer to the new <link linkend="GtkDialog">GtkDialog</link>.
  486. </entry></row>
  487. </tbody></tgroup></informaltable></refsect2>
  488. <refsect2>
  489. <title><anchor id="gimp-query-boolean-box">gimp_query_boolean_box ()</title>
  490. <programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_query_boolean_box          (const <link linkend="gchar">gchar</link> *title,
  491.                                              <link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
  492.                                              const <link linkend="gchar">gchar</link> *help_data,
  493.                                              <link linkend="gboolean">gboolean</link> eek,
  494.                                              const <link linkend="gchar">gchar</link> *message,
  495.                                              const <link linkend="gchar">gchar</link> *true_button,
  496.                                              const <link linkend="gchar">gchar</link> *false_button,
  497.                                              <link linkend="GtkObject">GtkObject</link> *object,
  498.                                              const <link linkend="gchar">gchar</link> *signal,
  499.                                              <link linkend="GimpQueryBooleanCallback">GimpQueryBooleanCallback</link> callback,
  500.                                              <link linkend="gpointer">gpointer</link> data);</programlisting>
  501. <para>
  502. </para>
  503. <para>
  504.  
  505. </para><informaltable pgwide=1 frame="none" role="params">
  506. <tgroup cols="2">
  507. <colspec colwidth="2*">
  508. <colspec colwidth="8*">
  509. <tbody>
  510. <row><entry align="right"><parameter>title</parameter> :</entry>
  511. <entry> The query box dialog's title.
  512. </entry></row>
  513. <row><entry align="right"><parameter>help_func</parameter> :</entry>
  514. <entry> The help function to show this dialog's help page.
  515. </entry></row>
  516. <row><entry align="right"><parameter>help_data</parameter> :</entry>
  517. <entry> A string pointing to this dialog's html help page.
  518. </entry></row>
  519. <row><entry align="right"><parameter>eek</parameter> :</entry>
  520. <entry> <link linkend="TRUE-CAPS">TRUE</link> if you want the "Eek" wilber to appear left of the dialog's
  521. message.
  522. </entry></row>
  523. <row><entry align="right"><parameter>message</parameter> :</entry>
  524. <entry> A string which will be shown in the query box.
  525. </entry></row>
  526. <row><entry align="right"><parameter>true_button</parameter> :</entry>
  527. <entry> The string to be shown in the dialog's left button.
  528. </entry></row>
  529. <row><entry align="right"><parameter>false_button</parameter> :</entry>
  530. <entry> The string to be shown in the dialog's right button.
  531. </entry></row>
  532. <row><entry align="right"><parameter>object</parameter> :</entry>
  533. <entry> The object this query box is associated with.
  534. </entry></row>
  535. <row><entry align="right"><parameter>signal</parameter> :</entry>
  536. <entry> The object's signal which will cause the query box to be closed.
  537. </entry></row>
  538. <row><entry align="right"><parameter>callback</parameter> :</entry>
  539. <entry> The function which will be called when the user clicks one
  540. of the buttons.
  541. </entry></row>
  542. <row><entry align="right"><parameter>data</parameter> :</entry>
  543. <entry> The callback's user data.
  544. </entry></row>
  545. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> A pointer to the new <link linkend="GtkDialog">GtkDialog</link>.
  546. </entry></row>
  547. </tbody></tgroup></informaltable></refsect2>
  548.  
  549. </refsect1>
  550.  
  551.  
  552.  
  553. <refsect1>
  554. <title>See Also</title>
  555. <para>
  556. GimpSizeEntry
  557. </para>
  558. <para>
  559. GimpUnitMenu
  560. </para>
  561. </refsect1>
  562.  
  563. </refentry>
  564.